Skip to content

docs: clarify ExecutionProps and TaskContext docs#21872

Merged
mbutrovich merged 1 commit intoapache:mainfrom
alamb:alamb/props_docs
Apr 27, 2026
Merged

docs: clarify ExecutionProps and TaskContext docs#21872
mbutrovich merged 1 commit intoapache:mainfrom
alamb:alamb/props_docs

Conversation

@alamb
Copy link
Copy Markdown
Contributor

@alamb alamb commented Apr 27, 2026

Which issue does this PR close?

Rationale for this change

While reviewing #21240 I found that the existing doc comments describing the relationship between ExecutionProps and TaskContext were vague

What changes are included in this PR?

  • Update the doc comments on ExecutionProps and TaskContext
  • Clarify why the two structures remain separate

Are these changes tested?

Not with automated tests. This is a comment-only change.

Are there any user-facing changes?

Docs only

@github-actions github-actions Bot added logical-expr Logical plan and expressions execution Related to the execution crate labels Apr 27, 2026
@alamb alamb added the documentation Improvements or additions to documentation label Apr 27, 2026
@alamb alamb marked this pull request as ready for review April 27, 2026 11:27
Copy link
Copy Markdown
Member

@asolimando asolimando left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great explanation, I learned about ExecutionProps which seems like a powerful tool to share state between logical and physical planning!

@mbutrovich mbutrovich added this pull request to the merge queue Apr 27, 2026
Merged via the queue into apache:main with commit bff0ffb Apr 27, 2026
36 of 37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation execution Related to the execution crate logical-expr Logical plan and expressions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants